home *** CD-ROM | disk | FTP | other *** search
/ PC World 2008 September / PCWorld_2008-09_cd.bin / v cisle / sadanastroju / interclue-1.5.6-fx.xpi / chrome / interclue / content / interclue.js < prev    next >
Text File  |  2008-06-17  |  39KB  |  1,180 lines
  1.  
  2. var interclue = window.interclue || {};
  3.  
  4. interclue.GUID = '{c33c5b47-69c8-45a4-a5e0-af85bbe628dd}';
  5.  
  6. interclue.isSiteHound = false;
  7.  
  8. interclue.isProfileDir = true;
  9.  
  10. interclue.servers = [];
  11.  
  12. interclue.servers.push({
  13.     'name' : 'live',
  14.     'url' : 'https://interclue.com',
  15.     'icon' : 'chrome://interclue/skin/buttons/server.live.png'});
  16.  
  17. interclue.servers.push({
  18.     'name' : 'local',
  19.     'url' : 'http://localhost/interclue',
  20.     'icon' : 'chrome://interclue/skin/buttons/server.local.png'});
  21.     
  22. interclue.servers.push({
  23.     'name' : 'dev',
  24.     'url' : 'http://dev.izeal.com/interclue.tabbed',
  25.     'icon' : 'chrome://interclue/skin/buttons/server.dev.png'});
  26.     
  27.  
  28. interclue.nextCall = '';
  29.  
  30.  
  31. interclue.fixNoScript = function(url, enable){
  32.     if (window.noscriptUtil){
  33.  
  34.         var ns = window.noscriptUtil.service;
  35.  
  36.         if (ns && ns.setJSEnabled){
  37.             ns.setJSEnabled(url, enable);
  38.         }
  39.     }
  40. }
  41.  
  42.  
  43. interclue.registerStylesheet = function(href){
  44.     //This code is from Conlan Wesson Link Alert v0.2
  45.     //who got it from Raphael Jolivet's smart-cursor v0.2
  46.  
  47.     // Get Style Sheet service
  48.     var sss = Components.classes["@mozilla.org/content/style-sheet-service;1"].getService(Components.interfaces.nsIStyleSheetService);
  49.     // Get IO service
  50.     var ios = Components.classes["@mozilla.org/network/io-service;1"].getService(Components.interfaces.nsIIOService);
  51.     // Build URI
  52.     var uri = ios.newURI(href, null, null);
  53.     // Register sheet
  54.     sss.loadAndRegisterSheet(uri, sss.USER_SHEET);
  55. }
  56.  
  57. interclue.unregisterStylesheet = function(href){
  58.     var sss = Components.classes["@mozilla.org/content/style-sheet-service;1"].getService(Components.interfaces.nsIStyleSheetService);
  59.     var ios = Components.classes["@mozilla.org/network/io-service;1"].getService(Components.interfaces.nsIIOService);
  60.     var uri = ios.newURI(href, null, null);
  61.     sss.unregisterSheet(uri, sss.USER_SHEET);
  62. }
  63.  
  64. interclue.inArray = function(needle, haystack){
  65.     for (var i=0; i<haystack.length; i++){
  66.         if (haystack[i] == needle){
  67.             return true;
  68.         }
  69.     }
  70.     return false;
  71. }
  72.  
  73. /**
  74. * load our scripts into the iframe
  75. */
  76. interclue.initClueBridge = function(){
  77.  
  78.     if (!interclue.inArray("platform-firefox.js", interclue.scripts)){
  79.         interclue.scripts.push("platform-firefox.js");
  80.     }
  81.     
  82.     //scripts must be loaded using a file:// path 
  83.     
  84.     // SiteHound installs Interclue into the Browser/extensions directory.
  85.     // however we install to the user's extension dir.
  86.     var dirGetId = (interclue.isSiteHound) ? "CurProcD" : "ProfD";
  87.     
  88.     //however I like to keep sitehound away from my install directory.
  89.     if (interclue.isProfileDir){
  90.         dirGetId = "ProfD";
  91.     }
  92.     
  93.     var dir = Components.classes["@mozilla.org/file/directory_service;1"].getService(Components.interfaces.nsIProperties).get(dirGetId, Components.interfaces.nsILocalFile).path;
  94.     var doc = document.getElementById('interclue-iframe').contentWindow.document;
  95.     var fileUrl = "file:///"+ dir.replace(/\\\//g, '/') +"/extensions/" + interclue.GUID +"/chrome/interclue/content/cluecore/";
  96.     
  97.     interclue.fixNoScript('file:', true);
  98.  
  99.     for (var i=0; i<interclue.scripts.length; i++){
  100.         interclue.addScript(fileUrl + interclue.scripts[i], doc);
  101.     }
  102.     
  103.     interclue.fixNoScript('file:', false);
  104.     
  105.     interclue.initKlib();
  106. }
  107.  
  108. /**
  109. * 
  110. */
  111. interclue.addScript = function(src, doc){
  112.     doc = doc || document;
  113.     var script = doc.createElement('script');
  114.     script.src = src;
  115.     script.type = 'text/javascript';
  116.     try {
  117.         doc.getElementsByTagName('head')[0].appendChild(script);
  118.     }catch(e){
  119.         doc.body.appendChild(script);
  120.     }
  121. }
  122.  
  123.  
  124. interclue.initKlib = function(){
  125.     var win = document.getElementById('interclue-iframe').contentWindow;
  126.  
  127.     if (win && win.Klib && win.Klib.init){
  128.         
  129.         win.Klib.init();
  130.         
  131.         if (interclue.nextCall){
  132.             var code = interclue.nextCall;
  133.             interclue.nextCall = '';
  134.             
  135.             var Klib = interclue.getKlib();
  136.             eval(code);
  137.         }
  138.         //show ready image?
  139.         win.Klib.Toolbar.refresh();
  140.     }
  141.     else {
  142.         setTimeout(interclue.initKlib, 100);
  143.     }
  144. }
  145.  
  146.  
  147. /**
  148. * 
  149. */
  150. interclue.call = function(code, event){
  151.  
  152.     //only activate on left click
  153.  
  154.     if (event && event.button == 2){return};
  155.  
  156.     var Klib = interclue.getKlib();
  157.     
  158.     if (Klib){
  159.         eval(code);
  160.     }
  161.     else {
  162.         interclue.nextCall = code;
  163.         interclue.initClueBridge();
  164.     }
  165. }
  166.  
  167.  
  168. interclue.getKlib = function(){
  169.     var iframe = document.getElementById('interclue-iframe');
  170.     
  171.     if (iframe && iframe.contentWindow && iframe.contentWindow.Klib && iframe.contentWindow.Klib.initalized){
  172.         return iframe.contentWindow.Klib;
  173.     }
  174.     else {
  175.         return null;
  176.     }
  177. }
  178.  
  179.  
  180.  
  181. interclue.handleClose = function(){
  182.     var Klib = interclue.getKlib();
  183.     
  184.     if (Klib){
  185.         Klib.GEvent.fireLocal('windowclose');
  186.     }
  187.     
  188.     gBrowser.removeEventListener("DOMContentLoaded", interclue.onBrowerDOMContentLoaded, false);
  189.     window.removeEventListener('close', interclue.handleClose, true);
  190.     window.removeEventListener('mousemove', interclue.handleMouseMove, true);
  191.     interclue.Mouse.cleanup();
  192. }
  193.  
  194. interclue.initalized = false;
  195.  
  196. interclue.init = function(){  
  197.  
  198.     if (gBrowser && !interclue.initalized){
  199.         interclue.initalized = true;
  200.         window.removeEventListener('load', interclue.init, true);
  201.         
  202.         interclue.setFirefoxVersionInfo();
  203.         //no longer used, statusbar button only.
  204.         //interclue.showToolbarButton('interclue-login-toolbarbutton');
  205.         //interclue.showToolbarButton('interclue-logout-toolbarbutton', 'interclue-login-toolbarbutton');
  206.         
  207.         interclue.Mouse.init();
  208.         interclue.Tooltip.init();
  209.         
  210.         gBrowser.addEventListener("DOMContentLoaded", interclue.onBrowerDOMContentLoaded, false);
  211.         
  212.         window.addEventListener('close', interclue.handleClose, true);
  213.         //window.addEventListener('keydown', interclue.handleKeyDown, true);
  214.         //window.addEventListener('keyup', interclue.handleKeyUp, true);
  215.         //window.addEventListener('blur', interclue.handleKeyUp, true);
  216.         
  217.         window.addEventListener('mousemove', interclue.handleMouseMove, true);
  218.         
  219.         //prevent printing of clueframes/linkscents        
  220.         interclue.registerStylesheet('chrome://interclue/content/linkscents.css');
  221.         
  222.         //cleanup unused preferences
  223.         interclue.killPref("alltheclues");
  224.         
  225.         interclue.uninstallObserver.register();
  226.         interclue.addEvent("uninstall-request", interclue.handleUninstallRequest);
  227.         interclue.addEvent("uninstall-cancel", interclue.handleUninstallCancel);
  228.         
  229.         if (interclue.getPref("interclue.resetPrefs") === true){
  230.             interclue.setPref("interclue.resetPrefs", false);
  231.             interclue.setPref("interclue.preferences", '');
  232.         }
  233.         
  234.         interclue.checkIfUpdated();
  235.         
  236.         //lets wait a moment and then do it
  237.         //adding delay due to unknown browser crash at startup.
  238.         //dont know why it's happening, but this appears to fix it.
  239.         setTimeout(function(){
  240.             document.getElementById('interclue-iframe').setAttribute('src', "chrome://interclue/content/cluecore/interclue.html");
  241.         }, 2000);
  242.         
  243.         //send update ping 2 minutes after browser start
  244.         interclue.updatePingTimer = setTimeout(interclue.updatePing, 2 * 60 * 1000);
  245.         
  246.         setTimeout(interclue.addAdblockExceptionRules, 2000);
  247.     }
  248. }
  249.  
  250.  
  251. /**
  252. * set firefox version info
  253. */
  254. interclue.setFirefoxVersionInfo = function(){
  255.     var verStr = interclue.getPref("extensions.lastAppVersion");
  256.     if (verStr){
  257.         var version = verStr.split(/\./g);
  258.         interclue.FFVersion = {};
  259.         interclue.FFVersion.major = parseInt(version[0]);
  260.         interclue.FFVersion.minor = version[1] ? parseInt(version[1]) : 0;
  261.         interclue.isFF2 = (interclue.FFVersion.major == 2);
  262.         interclue.isFF3 = (interclue.FFVersion.major == 3);
  263.     }
  264. }
  265. /**
  266. * handle DOM loaded event
  267. */
  268. interclue.onBrowerDOMContentLoaded = function(evt){
  269.     //get the right document
  270.     var doc = evt.originalTarget;
  271.     
  272.     if (doc && doc instanceof HTMLDocument){
  273.         //good to go
  274.         if (interclue.getPref("interclue.checkForEvilLinks", false)){
  275.             interclue.checkPageForEvilLinks(doc);
  276.         }
  277.     }
  278. }
  279.  
  280. /**
  281. * inserts icons next to evil links on a page 
  282. */
  283. interclue.checkPageForEvilLinks = function(doc){    
  284.     var links = doc.getElementsByTagName("a");
  285.     for (var i=0; i<links.length; i++){
  286.         //need to send this to a separate function so the callback works correctly
  287.         interclue.checkIfEvilLink(links[i]);     
  288.     }
  289. }
  290.  
  291. /**
  292. * inserts an icon next to a link if it is evil
  293. */
  294. interclue.checkIfEvilLink = function(link){
  295.  
  296.     var url = interclue.removeRedirects(link.href);
  297.  
  298.     //dont check invalid urls
  299.     if (!interclue.urlToURI(url)){return}
  300.     
  301.     //or internal links
  302.     if (interclue.isInternalLink(link)){return}
  303.     
  304.     interclue.isEvilURL(url, function(url, response){
  305.     
  306.         //make sure the link still exists.
  307.         if (!link){return}
  308.         
  309.         var tables = (response) ? response.split(/\s*\,\s*/g) : [];
  310.         for (var i=0; i<tables.length; i++){
  311.             switch(tables[i]){
  312.                 case "goog-malware-shavar":
  313.                     //is malware site.
  314.                     //better mark this lin as evil.
  315.                     link.setAttribute('interclue_link_type', 'malware');
  316.                     //interclue.insertIcon(link, "chrome://interclue/skin/warning-malware.png", "WARNING: visiting this web site may harm your computer!");
  317.                     break;
  318.                     
  319.                 case "goog-phish-shavar":
  320.                     //is phishing site
  321.                     link.setAttribute('interclue_link_type', 'phish');
  322.                     //interclue.insertIcon(link, "chrome://interclue/skin/warning-phishing.png", "WARNING: this site is thought to be a phishing (web forgery) scam");
  323.                     break;
  324.                 
  325.                 case "":
  326.                 case null:
  327.                     //link is safe
  328.                     break;
  329.                     
  330.                 default:
  331.                     //unknown table name, assume it's evil.
  332.                     interclue.logError(Error("Interclue: Unknown table name: ["+ response +"]"));
  333.             }
  334.         }
  335.     })
  336. }
  337.  
  338. /**
  339. * inserts an icon directly after a link
  340. */
  341. interclue.insertIcon = function(link, iconUrl, tooltip){
  342.     var doc = link.ownerDocument;
  343.     var img = doc.createElement("img");
  344.     img.setAttribute("src", iconUrl);
  345.     if (title){
  346.         img.setAttribute("title", tooltip);
  347.     }
  348.     img.setAttribute("align", "bottom");
  349.     img.setAttribute("border", "0");
  350.     
  351.     //we'll need to find this link if a user hovers over the icon.
  352.     //img.link //doesn't work
  353.     //just setting the same href will not work (their might be more than one link with the same url)
  354.     img.setAttribute("interclue_link_href", link.href);
  355.     var links = doc.getElementsByTagName('a');
  356.     for (var i=0; i<links.length; i++){
  357.         if (links[i] === link){
  358.             img.setAttribute("interclue_link_index", i);
  359.             break;
  360.         }
  361.     }
  362.     
  363.     //need to tell the linkscent positioner to adjust the linkscents position next to our image.
  364.     link.setAttribute("interclue_linkclue_offset_x", "18");
  365.     
  366.     interclue.insertAfter(img, link);
  367. }
  368.  
  369. /**
  370. * inserts an element directly after another element in a DOM
  371. */
  372. interclue.insertAfter = function(eleToInsert, ele){
  373.     if (ele.nextSibling){
  374.         ele.parentNode.insertBefore(eleToInsert, ele.nextSibling);
  375.     }
  376.     else {
  377.         ele.parentNode.appendChild(eleToInsert);
  378.     }
  379. }
  380.  
  381. /**
  382. * calls callback with 2 args, 1st arg is the url that as passed.
  383. * 2nd arg is a comma separated string of tables to which the url belongs
  384. * if url not found in any tables 2nd arg will be an empty string
  385. * if url is invalid 2nd arg will be null.
  386. */
  387. interclue.isEvilURL = function(url, callback){
  388.     //check url, invalid urls (or urls with other protocols) will throw an error 
  389.     //in FF2 phishWarden.isEvilURL().
  390.     if (/^http(s)?:/i.test(url) && interclue.urlToURI(url)){
  391.          
  392.         //firefox 2 uses a safbrowsing object
  393.         if (interclue.isFF2 && interclue.getPref("browser.safebrowsing.enabled", true) && !interclue.getPref("browser.safebrowsing.remoteLookups", false)){
  394.          
  395.             //firefox 2 uses a safebrowsing object to lookup urls
  396.             //the safebrowsing.phishWarden is not enabled immediatly so we need to check if it's ready and active
  397.             if (top.safebrowsing && top.safebrowsing.phishWarden && top.safebrowsing.phishWarden.isEvilURL){
  398.                 try {    
  399.                     top.safebrowsing.phishWarden.isEvilURL(url, function(arg){
  400.                         var IN_BLACKLIST = 0;
  401.                         var IN_WHITELIST = 1;
  402.                         var NOT_FOUND = 2;
  403.                         //if found in blacklist AND whitelist then IN_WHITELIST will be returned
  404.                         if (arg == IN_BLACKLIST){
  405.                             //convert to FF3 is phishy info
  406.                             callback(url, "goog-phish-shavar");
  407.                         }
  408.                         else {
  409.                             callback(url, "");
  410.                         }
  411.                     });
  412.                     return;
  413.                 }catch(e){}
  414.             }
  415.         }
  416.         //firefox 3 uses something else
  417.         else if (interclue.isFF3){
  418.             var uri = interclue.urlToURI(url);
  419.             if (uri && uri.spec && /^http(s)?:/.test(uri.spec)){
  420.                 //some urls (javascript: ) will throw a error if we try the lookup() on them.
  421.                 try {
  422.                     var nsIUrlClass = Components.classes["@mozilla.org/url-classifier/dbservice;1"]
  423.                         .getService(Components.interfaces.nsIUrlClassifierDBService);
  424.                     nsIUrlClass.lookup(uri.spec, function(response){
  425.                         callback(url, response);
  426.                     });
  427.                     return;
  428.                     
  429.                 }catch(e){
  430.                     //invalid URI?
  431.                     interclue.logError(e);
  432.                 }
  433.             }
  434.         }
  435.     }
  436.     //if we get here something has gone wrong
  437.     callback(url, null);
  438. }
  439.  
  440.  
  441.  
  442. /**
  443. * log an error to the error console
  444. */
  445. interclue.logError = function(err){
  446.     Components.utils.reportError(err); 
  447. }
  448.  
  449. /**
  450. * logs a message to the error console
  451. */
  452. interclue.logMsg = function(msg){
  453.     var str = "";
  454.     for (var i=0; i<arguments.length; i++){
  455.         str += arguments[i] + "\n";
  456.     }
  457.     
  458.     var consoleService = Components.classes["@mozilla.org/consoleservice;1"]
  459.         .getService(Components.interfaces.nsIConsoleService);
  460.     consoleService.logStringMessage("interclue:\n" + str);
  461. }
  462.  
  463. interclue.addAdblockExceptionRules = function(){
  464.     
  465.     //adblockplus (easylist subscription) rightly blocks amazon affiliate adds.
  466.     //but our summary of this type of link uses the amazon api to display info about the amazon product
  467.     //by adding a unique string (interclue=1) to the api url and 
  468.     //adding an exception rule we can display our summaries whilst still prevent normal adds from
  469.     //being displayed.
  470.     if (typeof abpTogglePattern == "function"){
  471.         abpTogglePattern("@@http://rcm.amazon.com/e/cm?interclue*", true);     
  472.         abpTogglePattern("@@http://rcm-images.amazon.com/images/*", true);     
  473.     }
  474. }
  475.  
  476. interclue.shutdown = function(evt){
  477.     try {
  478.         clearTimeout(interclue.updatePingTimer);
  479.     }catch(e){}
  480.     
  481.     
  482.     if (interclue.uninstallOnNextStart){
  483.         //remove prefs on uninstall
  484.         interclue.killPref("interclue");
  485.         interclue.savePrefFile();
  486.     }
  487. }
  488.  
  489. interclue.savePrefFile = function(){
  490.     var prefService = Components.classes["@mozilla.org/preferences-service;1"].getService(Components.interfaces.nsIPrefService);
  491.     prefService.savePrefFile(null);
  492. }
  493.  
  494. /**
  495. * Flag to indicate if interclue will be uninstalled on browser restart 
  496. */
  497. interclue.uninstallOnNextStart = false;
  498.  
  499. interclue.handleUninstallRequest = function(){
  500.  
  501.     //set a flag to indicate that interclue will be uninstalled
  502.     interclue.uninstallOnNextStart = true;
  503.     
  504.     //open the nag url.
  505.     var Klib = interclue.getKlib();
  506.     
  507.     if (Klib){
  508.         var url = "http://interclue.com/uninstall.html"
  509.         
  510.         url = Klib.Url.add(url, "build", Klib.App.build);
  511.         url = Klib.Url.add(url, "guid", Klib.User.getGuid());
  512.         
  513.         Klib.ClueBridge.openUrl(url, true, true, true);
  514.     }
  515. }
  516.  
  517.  
  518. interclue.handleUninstallCancel = function(){
  519.     interclue.uninstallOnNextStart = false;
  520. }
  521.  
  522.  
  523. //ref: http://xulsolutions.blogspot.com/2006/07/creating-uninstall-script-for.html
  524. interclue.uninstallObserver = {
  525.     
  526.     //flag to tell if item is to be uninstalled at next restart.
  527.     _uninstall : false,
  528.     
  529.     //handle observe event
  530.     observe : function(subject, topic, data) {
  531.         //action called
  532.         if (topic == "em-action-requested") {
  533.             subject.QueryInterface(Components.interfaces.nsIUpdateItem);
  534.  
  535.             if (subject.id == interclue.GUID) {
  536.                 //add-on being marked for uninstall
  537.                 if (data == "item-uninstalled") {
  538.                     this._uninstall = true;
  539.                     interclue.fireEvent("uninstall-request");
  540.                 } 
  541.                 //cancel uninstall
  542.                 else if (data == "item-cancel-action") {
  543.                     this._uninstall = false;
  544.                     interclue.fireEvent("uninstall-cancel");
  545.                 }
  546.             }
  547.         } 
  548.         //browser is closing
  549.         else if (topic == "quit-application-granted") {
  550.             if (this._uninstall) {
  551.                 /* uninstall stuff. */
  552.                 interclue.fireEvent("uninstall");
  553.             }
  554.             this.unregister();
  555.         }
  556.     },
  557.     
  558.     //start observing
  559.     register : function() {
  560.         var observerService = Components.classes["@mozilla.org/observer-service;1"].getService(Components.interfaces.nsIObserverService);
  561.         observerService.addObserver(this, "em-action-requested", false);
  562.         observerService.addObserver(this, "quit-application-granted", false);
  563.     },
  564.     
  565.     //stop observing
  566.     unregister : function() {
  567.         var observerService = Components.classes["@mozilla.org/observer-service;1"].getService(Components.interfaces.nsIObserverService);
  568.         observerService.removeObserver(this,"em-action-requested");
  569.         observerService.removeObserver(this,"quit-application-granted");
  570.     }
  571. }
  572.  
  573. interclue.handleMouseMove = function(evt){
  574.     //set a flag to say if the mouse currently over an html document.
  575.     var t = evt.target;
  576.     
  577.     interclue.isMouseOverHTMLDoc = (t && t.nodeName && t.getAttribute && t.nodeName == 'tabbrowser' && t.getAttribute('id') == 'content');
  578. }
  579.  
  580.  
  581. interclue.showToolbarButton = function(id, insertAfter){
  582.  
  583.     var navbar = document.getElementById('nav-bar');
  584.     var buttons = (navbar.currentSet) ? navbar.currentSet : navbar.defaultSet;
  585.  
  586.     if (buttons.indexOf(id) == -1){
  587.  
  588.         var set = buttons.split(/\s*,\s*/g);
  589.         var newSet = [];
  590.         var inserted = false;
  591.         
  592.         for (var i=0; i<set.length; i++){
  593.             newSet.push(set[i]);
  594.             if (insertAfter && set[i] == insertAfter){
  595.                 newSet.push(id);
  596.                 inserted = true;
  597.             }
  598.         }
  599.         
  600.         if (!inserted){
  601.             newSet.push(id);
  602.         }
  603.         newSet = newSet.join(','); 
  604.         navbar.currentSet = newSet;
  605.         navbar.setAttribute('currentset', newSet);
  606.         
  607.         //save the changes
  608.         document.persist("nav-bar","currentset"); 
  609.     }
  610. }
  611.  
  612.  
  613. interclue.initPref = function(name, initValue){
  614.     if (interclue.getPref(name, null) === null){
  615.         interclue.setPref(name, initValue);
  616.         return true;
  617.     }
  618.     else {
  619.         return false;
  620.     }
  621. }
  622.  
  623.  
  624. /**
  625. * 
  626. */
  627. interclue.getPref = function(name, defaultVal){
  628.     try{
  629.         var branch = Components.classes["@mozilla.org/preferences-service;1"].getService(Components.interfaces.nsIPrefBranch);
  630.         switch (branch.getPrefType(name)){
  631.             case 32 : //string
  632.                 return  branch.getCharPref(name);
  633.             case 64 : //int
  634.                 return branch.getIntPref(name);
  635.             case 128: //bool
  636.                 return branch.getBoolPref(name);
  637.         }
  638.     
  639.     }catch(e){}
  640.  
  641.     return defaultVal;
  642. }
  643.  
  644. interclue.setPref = function(name, val){
  645.  
  646.     //dont set prefs if we are about to uninstall the add-on
  647.     if (interclue.uninstallOnNextStart){return};
  648.  
  649.     var branch = Components.classes["@mozilla.org/preferences-service;1"].getService(Components.interfaces.nsIPrefBranch);
  650.     
  651.     if ((val === true) || (val === false)){
  652.         branch.setBoolPref(name, val);
  653.     }
  654.     else if (typeof val == 'string'){
  655.         branch.setCharPref(name, val);
  656.     }
  657.     else {
  658.         branch.setIntPref(name, val);
  659.     }
  660. }
  661.  
  662.  
  663. interclue.killPref = function(name){
  664.     var branch = Components.classes["@mozilla.org/preferences-service;1"].getService(Components.interfaces.nsIPrefBranch);
  665.     branch.deleteBranch(name);
  666. }
  667.  
  668.  
  669. //~ interclue.restart = function(event){
  670.     //~ if (event && event.button == 2){return};
  671.     //~ var startup = Components.interfaces.nsIAppStartup;
  672.     //~ Components.classes["@mozilla.org/toolkit/app-startup;1"].getService(startup).quit(startup.eRestart | startup.eAttemptQuit);
  673. //~ }
  674.  
  675.  
  676. //~ interclue.handleKeyDown = function(evt){
  677.  
  678.     //~ if (!interclue.keydown){
  679.         //~ interclue.keydown = true;
  680.         
  681.         //~ var Klib = interclue.getKlib();
  682.         //~ if (Klib && Klib.User.winLoggedIn){
  683.             //~ Klib.Clue.handleHotKeys(evt);
  684.         //~ }
  685.     //~ }
  686. //~ }
  687.  
  688. //~ interclue.handleKeyUp = function(evt){
  689.     //~ interclue.keydown = false;
  690.     
  691.     //~ var Klib = interclue.getKlib();
  692.     //~ if (Klib && Klib.User.winLoggedIn){
  693.         //~ Klib.Clue.fireHotKeyOff();
  694.     //~ }
  695. //~ }
  696.  
  697. interclue.events = {};
  698.  
  699. interclue.addEvent = function(evtName, func){
  700.     interclue.events[evtName] = interclue.events[evtName] || [];
  701.     interclue.events[evtName].push(func);
  702. }
  703.  
  704. interclue.removeEvent = function(evtName, func){
  705.  
  706.     if (interclue.events[evtName] && interclue.events[evtName].length){
  707.         var evts = [];
  708.         for (var i=0; i<interclue.events[evtName].length; i++){
  709.             if (interclue.events[evtName][i] != func){
  710.                 evts.push(interclue.events[evtName][i]);
  711.             }
  712.         }
  713.         interclue.events[evtName] = evts;
  714.     }
  715. }
  716.  
  717. interclue.fireEvent = function(evtName, args){
  718.     interclue.events[evtName] = interclue.events[evtName] || [];
  719.     for (var i=0; i<interclue.events[evtName].length; i++){
  720.         interclue.events[evtName][i](args);
  721.     }
  722. }
  723.  
  724. //hash table of hints that have already been viewed.
  725. interclue.hintsShown = {};
  726.  
  727. interclue.showHint = function(popupId, ele, imageURL, tutorialPage, x, y){
  728.     //can either be called with showHint(id, ele, [tooltipposition])
  729.     //of showHint(id, x, y, [tooltipposition]) 
  730.     
  731.     //would normally use boxObject to get dimentions but hintBox is collapsed so width & height are 0. 
  732.     var HINT_BOX_WIDTH = 354;
  733.     var HINT_BOX_HEIGHT = 219;
  734.     //perhaps it would be better to check the height and width after the first time it is viewed?
  735.     //maybe make it hidden and but not collapsed, then get the dimentions?
  736.     //for now am cheating
  737.     
  738.     var Klib = interclue.getKlib();
  739.     
  740.     //are we supposed to be showing this hint?
  741.     if (!interclue.hintsShown[popupId] && interclue.getKlib().Pref.get("hint."+ popupId +".show")){
  742.         interclue.hintsShown[popupId] = true;
  743.         
  744.         var popup = document.getElementById('interclue-hint-popup');
  745.         popup.popupId = popupId;
  746.         //set the message title, and text
  747.         document.getElementById('interclue-hint-title').value = Klib.string("hint."+ popupId +".title");
  748.         document.getElementById('interclue-hint-text').firstChild.data = Klib.string("hint."+ popupId +".text");
  749.         document.getElementById('interclue-hint-checkbox-dontshowagain').checked = false;
  750.         document.getElementById('interclue-hint-title-image').src = imageURL ? imageURL : '';
  751.         document.getElementById('interclue-hint-title-image').collapsed = imageURL ? false : true;
  752.         
  753.         var link = document.getElementById('interclue-hint-link');
  754.         if (tutorialPage){    
  755.             link.tutorialPage = tutorialPage; 
  756.             //link.setAttribute("value", Klib.string("hint.link.text"));
  757.             link.collapsed = false;
  758.         }
  759.         else {
  760.             link.collapsed = true;
  761.         }
  762.         //show hint
  763.         var browserBox = document.getElementById('main-window').boxObject;
  764.         
  765.         //position relative to an element?
  766.         if (ele){
  767.             
  768.             //choose the correct location for the popup depending on the elements location relative to the browser window
  769.             var eleBox = ele.ownerDocument.getBoxObjectFor(ele);
  770.             
  771.             x = eleBox.screenX;
  772.             y = eleBox.screenY;
  773.                 
  774.             //use tooltip positioning
  775.             //http://www.bekkoame.ne.jp/~poetlabo/WWW/XULref/common.html
  776.             
  777.             //where popup content should be anchored on the element
  778.             //popupanchor="none | topleft | topright | bottomleft | bottomright" 
  779.             
  780.             //which side of the popup content should be attached to the popupanchor. 
  781.             //popupalign="none | topleft | topright | bottomleft | bottomright" 
  782.             
  783.             
  784.             //popup.showPopup(document.getElementById("interclue-statusbarpanel"), x, y, "popup", popupanchor, popupalign);
  785.         }
  786.         
  787.         //position the hint box.
  788.         var hor = ((x + HINT_BOX_WIDTH) >= (browserBox.screenX + browserBox.width)) ? "right" : "left";
  789.         var ver = ((y + HINT_BOX_HEIGHT) >= (browserBox.screenY + browserBox.height)) ? "bottom" : "top";
  790.         
  791.         //adjust for direction and drop shadow
  792.         if (hor == "right"){
  793.             x -= HINT_BOX_WIDTH;
  794.             x += 10;
  795.         }
  796.         if (ver == "bottom"){
  797.             y -= HINT_BOX_HEIGHT;
  798.             y += 10;
  799.         }
  800.         popup.className = "interclue-hint-"+ ver +"-"+ hor;
  801.         
  802.         //adjust spacers 
  803.         document.getElementById("interclue-hint-popup-spacer-top").setAttribute("height", (ver == "bottom") ? 8 : 37); 
  804.         document.getElementById("interclue-hint-popup-spacer-bottom").setAttribute("height", (ver == "bottom") ? 37 : 8); 
  805.         
  806.         //show the popup
  807.         popup.showPopup(document.getElementById("interclue-statusbarpanel"), x, y, "popup", null, null);
  808.     }
  809. }
  810.  
  811. interclue.closeHint = function(){
  812.  
  813.     var popup = document.getElementById('interclue-hint-popup');
  814.     popup.hidePopup();
  815.     
  816.     if (document.getElementById('interclue-hint-checkbox-dontshowagain').checked){
  817.         var popupId = popup.popupId;
  818.         //and save into prefs.
  819.         interclue.getKlib().Pref.set("hint."+ popupId +".show", false);
  820.     }
  821. }
  822.  
  823. interclue.showTutorialPage = function(page){
  824.     var Klib = interclue.getKlib();
  825.     Klib.Tutorial.showTutorial(page);
  826.     interclue.closeHint();
  827. }
  828.  
  829. /**
  830. * once a day ping the update server.
  831. */
  832. interclue.updatePing = function(){
  833.     
  834.     var Klib = interclue.getKlib();
  835.     
  836.     if (Klib){
  837.         Klib.Update.checkForUpdates();
  838.         //try again tomorrow (in case the user likes to keep firefox running for more than 24 hours at a time).
  839.         interclue.updatePingTimer = setTimeout(interclue.updatePing, 24 * 60 * 60 * 1000);    
  840.     }
  841.     else {
  842.         //Klib not initalized, try again in 5 minutes.
  843.         interclue.updatePingTimer = setTimeout(interclue.updatePing, 5 * 60 * 1000);    
  844.     }
  845. }
  846.  
  847. interclue.enable = function(){
  848.     interclue.call("Klib.ClueBridge.setState('enabled')");
  849. }
  850. interclue.disableDomain = function(){
  851.     interclue.call("Klib.ClueBridge.setState('disabled-for-domain')");
  852. }
  853. interclue.disableUntilRestart = function(){
  854.     interclue.call("Klib.ClueBridge.setState('disabled-until-restart')");
  855. }
  856. interclue.disable = function(){
  857.     interclue.call("Klib.ClueBridge.setState('disabled')");
  858. }
  859.  
  860. /**
  861. * read a value from the registry
  862. */
  863. interclue.getRegistryValue = function(key){
  864.     
  865.     var wrk = Components.classes["@mozilla.org/windows-registry-key;1"].createInstance(Components.interfaces.nsIWindowsRegKey);
  866.     
  867.     //accept slashes and backslashes
  868.     key = key.replace(/[\\\/]+/g, '\\');
  869.     
  870.     //split the key into root/path/node segments
  871.     var m = key.match(/^([^\\]+)\\(.+)\\([^\\]+)$/);
  872.     
  873.     if (m){
  874.         var root = m[1].toUpperCase();
  875.         var path = m[2];
  876.         var node = m[3];
  877.         var rootNode;
  878.         
  879.         switch (root){
  880.             case "HKCR": 
  881.             case "HKEY_CLASSES_ROOT":
  882.                 rootNode = wrk.ROOT_KEY_CLASSES_ROOT;
  883.                 break;
  884.                 
  885.             case "HKCU": 
  886.             case "HKEY_CURRENT_USER":
  887.                 rootNode = wrk.ROOT_KEY_CURRENT_USER;
  888.                 break;
  889.             
  890.             case "HKLM": 
  891.             case "HKEY_LOCAL_MACHINE":
  892.                 rootNode = wrk.ROOT_KEY_LOCAL_MACHINE;
  893.                 break;
  894.             
  895.             default:
  896.                 throw Error("Interclue:registry: Invalid root node ["+ root +"]");
  897.         }
  898.         
  899.         //path needs to have backslashes (\) escaped.
  900.         
  901.         try {
  902.             wrk.open(rootNode, path, wrk.ACCESS_READ);
  903.         }catch(e){
  904.             //Failed, assume key doesn't exist?
  905.             return null;
  906.         }
  907.         
  908.         var val;
  909.         switch (wrk.getValueType(node)) {
  910.             case wrk.TYPE_STRING:
  911.                 val = wrk.readStringValue(node);
  912.                 break;
  913.             case wrk.TYPE_BINARY:
  914.                 val = wrk.readBinaryValue(node);
  915.                 break;
  916.             case wrk.TYPE_INT:
  917.                 val = wrk.readIntValue(node);
  918.                 break;
  919.             case wrk.TYPE_INT64:
  920.                 val = wrk.readInt64Value(node);
  921.                 break;
  922.             default:
  923.                 val = null;
  924.         }
  925.         wrk.close();
  926.         return val;
  927.     }
  928.     else {
  929.         throw Error("Invalid registry path ["+ key +"]");
  930.     }
  931. }
  932.  
  933. /**
  934. * return the current Operating System 
  935. * returns "WINNT" on Windows Vista, XP, 2000, and NT systems
  936. * and returns "Linux" on GNU/Linux
  937. */
  938. interclue.getOS = function(){
  939.     return Components.classes["@mozilla.org/xre/app-info;1"].getService(Components.interfaces.nsIXULRuntime).OS;
  940. }
  941.  
  942. /**
  943. * return TRUE is operating system is Windows based (NT, 2000, XP, Vista)
  944. */
  945. interclue.isWindows = function(){
  946.     return (interclue.getOS() == "WINNT");
  947. }
  948.  
  949. /**
  950. * return TRUE is file exists
  951. */
  952. interclue.fileExists = function(path){
  953.     var file = Components.classes["@mozilla.org/file/local;1"].createInstance(Components.interfaces.nsILocalFile);
  954.     file.initWithPath(path);
  955.     return file.exists();
  956. }
  957.  
  958. /**
  959. * creates a temporary file and writes the given data to it
  960. * returns the path to the temporary file
  961. */
  962. interclue.writeTempFile = function(data){
  963.     var file = Components.classes["@mozilla.org/file/directory_service;1"].getService(Components.interfaces.nsIProperties).get("TmpD", Components.interfaces.nsIFile);
  964.     file.append("interclue.tmp");
  965.     file.createUnique(Components.interfaces.nsIFile.NORMAL_FILE_TYPE, 0666);
  966.     
  967.     // file is nsIFile, data is a string
  968.     var foStream = Components.classes["@mozilla.org/network/file-output-stream;1"].createInstance(Components.interfaces.nsIFileOutputStream);
  969.     
  970.     // use 0x02 | 0x10 to open file for appending.
  971.     foStream.init(file, 0x02 | 0x08 | 0x20, 0666, 0); 
  972.     // write, create, truncate
  973.     //In a c file operation, we have no need to set file mode with or operation, 
  974.     //directly using "r" or "w" usually.
  975.     foStream.write(data, data.length);
  976.     foStream.close();
  977.  
  978.     return file.path;
  979. }
  980.  
  981.  
  982.  
  983.  
  984. /**
  985. * Executes a command as if it were entered onto the command line
  986. *  @fullPathToExe: string : full path to executable to call (eg "c:\windows\notepad.exe")
  987. *  @args: array : Array of command line arguments to add (eg ["/new",  "--help"])?
  988. */
  989. interclue.exec = function(fullPathToExe, args, waitOnReturn){
  990.     
  991.     var file = Components.classes["@mozilla.org/file/local;1"].createInstance(Components.interfaces.nsILocalFile);
  992.     file.initWithPath(fullPathToExe);
  993.  
  994.     var process = Components.classes["@mozilla.org/process/util;1"].createInstance(Components.interfaces.nsIProcess);
  995.     process.init(file);
  996.  
  997.     // Run the process.
  998.     var wait = waitOnReturn ? true : false;
  999.     process.run(wait, args, args.length);
  1000. }
  1001.  
  1002. /**
  1003. * 
  1004. */
  1005. interclue.checkIfUpdated = function(){
  1006.     var Klib = interclue.getKlib();
  1007.     
  1008.     if (Klib){
  1009.         Klib.Update.runUpdateScripts();
  1010.     }
  1011.     else {
  1012.         //try again in a moment
  1013.         setTimeout(interclue.checkIfUpdated , 2000)
  1014.     }
  1015. }
  1016.  
  1017. /**
  1018. * return the zoom level of the currently visible (focused) document in FF3
  1019. * returns 0 if zoom level is unavailable (FF < 3)
  1020. */
  1021. interclue.getCurrentDocZoomLevel = function(){
  1022.     var level = getBrowser().mCurrentBrowser.markupDocumentViewer.fullZoom;
  1023.     return (typeof level == "number") ? level : 1;
  1024. }
  1025.  
  1026. /**
  1027. * converts a URL string to a URI that is used in many firefox functions
  1028.  
  1029. == example URI returned from "http://www.mozilla.com/en-US/" ==
  1030.  
  1031. spec=http://www.mozilla.com/en-US/
  1032. prePath=http://www.mozilla.com
  1033. scheme=http
  1034. userPass=
  1035. username=
  1036. password=
  1037. hostPort=www.mozilla.com
  1038. host=www.mozilla.com
  1039. port=-1
  1040. path=/en-US/
  1041. */
  1042.  
  1043. interclue.urlToURI = function(url){
  1044.     try {
  1045.         return Components.classes["@mozilla.org/network/io-service;1"].getService(Components.interfaces.nsIIOService).newURI(url, null, null);
  1046.     }catch(e){
  1047.         return null;
  1048.     }
  1049. }
  1050.  
  1051.  
  1052. /**
  1053. * keep track of where the mouse is over our browser
  1054. */
  1055. interclue.Mouse = {};
  1056. interclue.Mouse.screenX = 0;
  1057. interclue.Mouse.screenY = 0;
  1058. interclue.Mouse.init = function(){
  1059.     window.addEventListener("mousemove", interclue.Mouse.onMouseMove, false);
  1060. }
  1061. interclue.Mouse.cleanup = function(){
  1062.     window.removeEventListener("mousemove", interclue.Mouse.onMouseMove, false);
  1063. }
  1064. interclue.Mouse.onMouseMove = function(evt){
  1065.     interclue.Mouse.screenX = evt.screenX;
  1066.     interclue.Mouse.screenY = evt.screenY;
  1067. }
  1068.  
  1069.  
  1070. /**
  1071. * the interclue tooltip
  1072. */
  1073. interclue.Tooltip = {}
  1074. interclue.Tooltip.init = function(){
  1075.     //attach functions to the tooltip object
  1076.     var tooltip = document.getElementById("interclue-tooltip");
  1077.     tooltip.startHideTimer = interclue.Tooltip.startHideTimer;
  1078.     tooltip.stopHideTimer = interclue.Tooltip.stopHideTimer;
  1079. }
  1080. /**
  1081. * starts the hide timer
  1082. */
  1083. interclue.Tooltip.startHideTimer = function(){
  1084.  
  1085.     var tooltip = document.getElementById("interclue-tooltip");
  1086.     var delay = parseInt(tooltip.getAttribute("hidedelay"));
  1087.     tooltip.stopHideTimer();
  1088.     tooltip.hideTimer = setTimeout(function(){
  1089.         tooltip.hidePopup()
  1090.     }, 4000);
  1091. }
  1092. /**
  1093. * stop the hide timer
  1094. * NOTE: this doesn't work in FF2, any attempt to move the mouse over the tooltip will hide it!
  1095. */
  1096. interclue.Tooltip.stopHideTimer = function(){
  1097.     var tooltip = document.getElementById("interclue-tooltip");
  1098.     if (tooltip.hideTimer){
  1099.         clearTimeout(tooltip.hideTimer);
  1100.     }
  1101. }
  1102. /**
  1103. * shows the tooltip
  1104. */
  1105. interclue.Tooltip.show = function(text, screenX, screenY){
  1106.     //set the text of the tooltip
  1107.     var desc = document.getElementById("interclue-tooltip-description");
  1108.     if (desc.firstChild && desc.firstChild.nodeType == 3){
  1109.         desc.firstChild.data = text;
  1110.     }
  1111.     else {
  1112.         var textnode = document.createTextNode(text);
  1113.         desc.appendChild(textnode);
  1114.     }  
  1115.     //and show the tooltip
  1116.     screenX = screenX || interclue.Mouse.screenX;
  1117.     screenY = screenY || interclue.Mouse.screenY;
  1118.     
  1119.     //have to put this in a timer here, 
  1120.     //otherwise the tooltip just doesn't show, dont know why?
  1121.     setTimeout(function(){
  1122.         var tooltip = document.getElementById("interclue-tooltip");
  1123.         tooltip.text = text;
  1124.         if (typeof tooltip.openPopupAtScreen == "function"){
  1125.             tooltip.openPopupAtScreen(screenX, screenY);
  1126.         }
  1127.         //FF2 doesn't support openPopupAtScreen
  1128.         else {
  1129.             //use tooltip positioning
  1130.             //http://www.bekkoame.ne.jp/~poetlabo/WWW/XULref/common.html
  1131.             
  1132.             //where popup content should be anchored on the element
  1133.             //popupanchor="none | topleft | topright | bottomleft | bottomright" 
  1134.             
  1135.             //which side of the popup content should be attached to the popupanchor. 
  1136.             //popupalign="none | topleft | topright | bottomleft | bottomright" 
  1137.             
  1138.             tooltip.showPopup(document.getElementById("main-window"), screenX, screenY, "tooltip", "bottomleft", "bottomleft");
  1139.         }
  1140.     }, 50);   
  1141. }
  1142.  
  1143.  
  1144. interclue.redirects = {};
  1145. interclue.redirects["google"] = function(url){
  1146.     //check for google redirections
  1147.     var m = url.match(/^http:\/\/[^\.]+.google.[^\/]+\/interstitial\?url=([^&]+)/i);
  1148.     return m ? decodeURIComponent(m[1]) : url;
  1149. }
  1150.  
  1151. /**
  1152. * removes known redirects from a url
  1153. */
  1154. interclue.removeRedirects = function(url){
  1155.     //assume each redirect will only occur once
  1156.     for(var id in interclue.redirects){
  1157.         url = interclue.redirects[id](url);
  1158.     }
  1159.     return url;
  1160. }
  1161.  
  1162. /**
  1163. * return TRUE if link points to the same domain as the page it is on.
  1164. */
  1165. interclue.isInternalLink = function(link){
  1166.     var docURI = interclue.urlToURI(link.ownerDocument.URL);
  1167.     var linkURL = interclue.removeRedirects(link.href);
  1168.     var linkURI = interclue.urlToURI(linkURL);
  1169.     
  1170.     return (docURI && linkURI && docURI.host && docURI.scheme && docURI.scheme == linkURI.scheme && docURI.host == linkURI.host);
  1171. }
  1172.  
  1173. /**
  1174. * duh
  1175. */
  1176.  
  1177.  
  1178. window.addEventListener('load', interclue.init, true);
  1179. window.addEventListener('close', interclue.shutdown, true);
  1180.